Справочная система#

Справочная система предназначена для настройки справочной информации, которая открывается из пользовательских интерфейсов системы с помощью операции Помощь (F1).

Если операция Помощь (F1) выведена в пользовательском интерфейсе, при ее вызове справа открывается панель со справочной статьей. Система выводит статью, сопоставленную с выборкой или отображением, из которого была вызвана справка.

Путь: Настройка системы > Настройки и сервисы > Настройка справочных статей.

В настройке справочных статей можно создавать новые справочные статьи, редактировать уже созданные статьи и привязывать их к нужному модулю.

Интерфейс настройки справочных статей#

Форма настройки справочных статей используется для просмотра, создания и редактирования справочных статей.

Чтобы открыть или отредактировать существующую статью, выберите ее в списке. В области детализации откроется карточка выбранной справочной статьи.

В карточке статьи доступны вкладки:

Статья;
Атрибуты;
Операции;
Прикрепленные файлы;
Предпросмотр статьи.

Основной текст статьи оформляется с использованием Markdown. Подробнее см. в Руководстве по написанию документации.

Основные атрибуты статьи#

В карточке справочной статьи заполняются основные атрибуты:

Системное имя — системное имя выборки и варианта отображения, для которых должна выводиться статья. Указывается в формате Название_выборки.Вариант_отображения. Например: Mct_SettingAvi.ListSet
Наименование — наименование статьи;
Папка — системное имя папки, в которой размещается статья. Используется для группировки справочных статей. Если статья не является подстатьей, по умолчанию она создается в корне дерева. Чтобы создать папку, достаточно указать имя папки в этом поле. Чтобы удалить статью из папки, достаточно очистить значение поля Папка;
Описание — краткое описание статьи;
Тип статьи — тип создаваемой справочной статьи;
Порядковый номер — порядок отображения дочерней статьи внутри основной справочной статьи. Доступен для заполнения только для подстатьи;
Уровень — уровень отображения дочерней статьи внутри основной справочной статьи. Используется для определения порядка и вложенности отображения. Недоступен для заполнения в родительской статье. Может использоваться как дополнительный способ сортировки, если для нескольких подстатей указан одинаковый порядковый номер;
Ссылка на основную статью — заполняется для подстатей;
Модуль — модуль, к которому относится статья. Следует указывать модуль, содержащий объект, выборку или отображение, описываемые в статье;
Номер версии — версия статьи;
Тип слияния — способ добавления содержимого дочерней статьи в основную справочную статью. Доступен для заполнения только для дочерней статьи. Возможные значения:
- Добавить в конец — добавляет описание после существующего содержимого раздела;
- Добавить в начало — добавляет описание перед существующим содержимым раздела;
- Заменить — заменяет существующее содержимое раздела новым описанием.

Вкладка «Статья»#

На вкладке Статья заполняются атрибуты статьи и основной текст.

Основной текст вводится в поле Контент. В статье рекомендуется указать:

общее описание объекта системы;
назначение объекта;
основные сценарии использования;
особенности работы формы;
значение цветовой индикации строк и атрибутов, если она используется в соответствующем отображении.

Вкладка «Атрибуты»#

На вкладке Атрибуты заполняется перечень атрибутов выборки, которые должны быть описаны в справочной статье.

Чтобы атрибуты отображались в статье, для каждого нужного атрибута должны быть заполнены:

Тип слияния;
текстовое описание атрибута.

Если для атрибута не заполнено текстовое описание, он не будет выведен в итоговой справочной статье.

Добавить атрибуты можно с помощью операций:

Добавить атрибуты — система открывает список всех атрибутов заданной выборки. В статью добавляются выбранные атрибуты;
Добавить по метаданным — система добавляет атрибуты выборки по метаданным, определенным для системного имени статьи.

Операция Добавить по метаданным вызывается из группы операций, расположенной под кнопкой с иконкой «молоточки».

При добавлении по метаданным система добавляет все атрибуты выборки, включая атрибуты панели фильтрации. Для атрибутов панели фильтрации в поле Раздел добавляется значение Атрибуты панели фильтрации. В поле Группа добавляется наименование группы атрибутов.

В справочной статье для каждого раздела выводится отдельная таблица с заданным наименованием. Для группы внутри таблицы выводится отдельная строка с наименованием группы.

Для работы с атрибутами также доступны операции:

Сохранить в файл — сохраняет выделенные атрибуты в файл .json;
Загрузить из JSON файла — загружает атрибуты из файла .json.

Вкладка «Операции»#

Вкладка Операции заполняется аналогично вкладке Атрибуты, но используется для описания операций выборки.

Чтобы операции отображались в статье, для каждой нужной операции должны быть заполнены:

Тип слияния;
текстовое описание операции.

Если для операции не заполнено текстовое описание, она не будет выведена в итоговой справочной статье.

На вкладке указываются операции, которые должны быть отображены в справочной статье, и их описание.

Добавить операции можно вручную или по метаданным. Для заполнения операций по метаданным вызовите операцию Добавить по метаданным из группы операций, расположенной под кнопкой с иконкой «молоточки».

Для работы с операциями также доступны операции:

Сохранить в файл — сохраняет выделенные операции в файл .json;
Загрузить из JSON файла — загружает операции из файла .json.

Вкладка «Прикрепленные файлы»#

Вкладка Прикрепленные файлы используется для хранения файлов, которые можно вставлять в текст статьи или предоставлять пользователю для скачивания.

Прикрепленные файлы можно использовать:

для вставки изображений в текст статьи;
для добавления файлов, доступных для скачивания;
для хранения материалов, связанных со справочной статьей.

Чтобы прикрепить файл:

Откройте вкладку Прикрепленные файлы.
В группе операций вставки выберите добавление нового файла.
Загрузите файл.

После добавления файла система формирует ссылки в формате Markdown. Эти ссылки можно скопировать и вставить в текст статьи.

Для изображений рекомендуется указывать alt-текст, чтобы ссылка в Markdown была понятной:

![Описание изображения](ссылка-на-файл)

Чтобы файл был добавлен в перечень прикрепленных файлов в конце статьи, установите признак Показать в статье.

Для прикрепленных файлов также доступны операции загрузки и выгрузки через JSON-файл.

Вкладка «Предпросмотр статьи»#

На вкладке Предпросмотр статьи можно проверить, как статья будет выглядеть в формате HTML и в пользовательском интерфейсе.

Чтобы в статье отображалось сгенерированное содержание по заголовкам, нажмите Отображать содержание.

Техническая структура справочной статьи#

Справочная статья формируется на основе нескольких связанных объектов.

Вкладка	Объект	Назначение
Статья	`Btk_HlpTopic`	Основной объект справочной статьи. Содержимое статьи хранится в атрибуте `sContent`.
Атрибуты	`Btk_HlpTopicDet` с типом Атрибут	Описывает атрибуты выборки, которые должны отображаться в справочной статье.
Операции	`Btk_HlpTopicDet` с типом Операция	Описывает операции выборки, которые должны отображаться в справочной статье.
Прикрепленные файлы	`Btk_HlpTopicAttach`	Хранит файлы, связанные со справочной статьей. Файлы можно использовать для вставки изображений в текст статьи или для скачивания.
Предпросмотр статьи	—	Отображает HTML, сгенерированный по данным статьи, атрибутам, операциям и прикрепленным файлам.

Создание справочной статьи#

Справочную статью можно создать:

из интерфейса справочной системы;
из выборки или экранной формы, для которой требуется настроить справку.

Создание статьи из интерфейса справочной системы#

Для создания справочной статьи из интерфейса справочной системы:

Откройте настройку справочных статей.
Нажмите Создать. Система создаст пустую статью в справочной системе.
Заполните основные атрибуты статьи.
Заполните содержимое статьи на вкладках Статья, Атрибуты, Операции, Прикрепленные файлы.
Проверьте результат на вкладке Предпросмотр статьи.
Нажмите Сохранить.

В контекстном меню кнопки Создать доступны дополнительные способы создания справочной статьи:

Создать по шаблону — создает статью на основе готового шаблона. Можно использовать существующие шаблоны или создать собственные шаблоны с заранее подготовленной структурой наполнения;
Создать по метаданным — создает статью по системному имени выборки и отображения. Системное имя статьи указывается по шаблону: Простое_имя_выборки.Имя_отображения;
Создать подстатью — создает дочернюю статью для выбранной статьи. При создании подстатьи указывается тип слияния. Также дочернюю статью можно создать, если выбрать родительскую статью и нажать Создать.

Создание статьи из выборки#

Справочную статью можно создать непосредственно из выборки или экранной формы, для которой требуется настроить справку.

Для создания статьи из выборки:

Откройте нужную экранную форму.
Нажмите Редактировать справку. Операция может быть расположена на панели инструментов или в контекстном меню.
Если статья еще не создана, система выведет сообщение с предложением создать ее.
Подтвердите создание статьи.
После подтверждения система создаст и откроет статью.
Заполните основные атрибуты и содержимое статьи.
Нажмите Сохранить.
Обновите страницу или повторно откройте форму.

После сохранения статьи и обновления формы в верхнем фрейме выбранного отображения появляется иконка Помощь. При ее вызове система открывает панель с соответствующей справочной статьей.

Перенос справочных статей на другую базу#

Перенос справочных статей на другую базу можно выполнить двумя способами:

с помощью операций выгрузки и загрузки статей через файл (предпочтительный способ);
средствами менеджера конфигурации.

При переносе через файл используются операции:

Сохранить выделенные статьи в файл — выполняется на базе, из которой переносятся статьи;
Загрузить статьи из файла — выполняется на базе, в которую загружаются статьи.

Справочная система

Содержание